split-on-first

What is split-on-first?

The split-on-first npm package is a simple utility that allows you to split a string on the first occurrence of a specified separator. This is particularly useful when you need to parse strings where only the first separator is significant and subsequent separators are part of the remaining substring.

What are split-on-first's main functionalities?

Splitting a string on the first occurrence of a separator

This function splits the string 'a,b,c,d' on the first comma. The result is an array with two elements: the substring before the first comma ('a') and the substring after the first comma ('b,c,d').

"a,b,c,d".splitOnFirst(',')

Other packages similar to split-on-first

split

The 'split' package offers functionality to split strings based on a delimiter, but it splits on every occurrence of the delimiter, not just the first. This makes 'split-on-first' more suitable for cases where only the first delimiter is significant.

string.prototype.split

This is the native JavaScript split method available on string instances. It also splits on every occurrence of the specified separator. Unlike 'split-on-first', it does not limit the split to the first occurrence, which can lead to different use cases.

README

split-on-first

Split a string on the first occurrence of a given separator

This is similar to String#split(), but that one splits on all the occurrences, not just the first one.

Install

$ npm install split-on-first

Usage

import splitOnFirst from 'split-on-first';

splitOnFirst('a-b-c', '-');
//=> ['a', 'b-c']

splitOnFirst('key:value:value2', ':');
//=> ['key', 'value:value2']

splitOnFirst('a---b---c', '---');
//=> ['a', 'b---c']

splitOnFirst('a-b-c', '+');
//=> []

splitOnFirst('abc', '');
//=> []

API

splitOnFirst(string, separator)

string

Type: string

The string to split.

separator

Type: string

The separator to split on.

Related

• split-at - Split a string at one or more indices